/*
 * Copyright (c) 2007, 2011, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.sun.max.asm.gen.cisc.x86;

import java.util.*;

import com.sun.max.asm.*;
import com.sun.max.asm.gen.*;
import com.sun.max.program.*;

/**
 * An explicit operand, specifying an assembler method parameter.
 */
public abstract class X86Parameter extends X86Operand implements Parameter {

    private final ParameterPlace place;

    protected X86Parameter(X86Operand.Designation designation, ParameterPlace place) {
        super(designation);
        this.place = place;
    }

    public ParameterPlace place() {
        return place;
    }

    private String variableName = "p";

    public void setVariableName(String variableName) {
        this.variableName = variableName;
    }

    public String variableName() {
        return variableName;
    }

    private ArgumentRange argumentRange;

    public ArgumentRange argumentRange() {
        return argumentRange;
    }

    public void setArgumentRange(ArgumentRange argumentRange) {
        this.argumentRange = argumentRange;
    }

    private Set<Argument> excludedDisassemblerTestArguments = new HashSet<Argument>();
    private Set<Argument> excludedExternalTestArguments = new HashSet<Argument>();

    public void excludeTestArguments(TestArgumentExclusion testArgumentExclusion) {
        switch (testArgumentExclusion.component()) {
            case DISASSEMBLER:
                excludedDisassemblerTestArguments = testArgumentExclusion.arguments();
                break;
            case EXTERNAL_ASSEMBLER:
                excludedExternalTestArguments = testArgumentExclusion.arguments();
                break;
            default:
                throw ProgramError.unexpected();
        }
    }

    public Set<Argument> excludedDisassemblerTestArguments() {
        return excludedDisassemblerTestArguments;
    }

    public Set<Argument> excludedExternalTestArguments() {
        return excludedExternalTestArguments;
    }

    public int compareTo(Parameter other) {
        return type().getName().compareTo(other.type().getName());
    }
}
